Errors CGM

1.0.x
(0 reviews)

Release and Environment

Note: Remove this line and the content below (highlighted in Italics) in this section and update your Asset details.

The Release and Environments section of API documentation is essential for providing clarity on the different versions of the API and the environments in which it can be utilized. Here are some key components to consider including in this section:

Versioning: Clearly outline the different versions of the API, including any backward compatibility considerations and version-specific features or changes. This helps users understand the evolution of the API and how it may impact their implementations.

Release Notes: Provide a summary of the changes, enhancements, bug fixes, and new features introduced in each API version. This helps users stay informed about the evolution of the API and its capabilities.

Supported Environments: Detail the environments (e.g., development, testing, production) in which the API can be utilized, along with any specific configuration requirements or considerations for each environment.

Change Management: Outline the process for managing changes to the API, including version control, deprecation policies, and communication of changes to users.

API Lifecycle: Explain the lifecycle of the API, including how releases are planned, developed, tested, and deployed, as well as any retirement or sunset plans for older versions.

Note: Example is provided below

Example:

API Version: 1.2.1 - Latest Version

Release Date: Dec 19, 2019

End-of-Life Date: No Retirement planned yet

Change Number: CHG123456

Features: This version adds the following features

  • Extended solution with subscription API using MQ queues.

API Version: 1.2.0 To be Deprecated Soon

Release Date: Dec 10, 2018

End-of-Life Date: Dec 09, 2022

Change Number: CHG123456

Features: This version adds the following features

  • Initial development.

API Version: 1.0.0 Deprecated

Release Date: Dec 10, 2017

End-of-Life Date: Dec 09, 2018

Change Number: CHG123456

Features: This version adds the following features

  • Initial development.

Environment

Note: Remove this line and edit the content below (highlighted in Italics) as per your asset details.
| Environment | Version | URL |
| -------- | -------- | -------- |
| Production | version-number | https://prod-\.apis.roche.com/\/v1/\|
| Stage | version-number | https://stage-\.apis.roche.com/\-stage/v1/\|
| Test | version-number | https://test-\.apis.roche.com/\-test/v1/\|
| Development | version-number | https://dev-\.apis.roche.com/\-dev/v1/\|

Reviews